GET api/communication/campaign?communicationType[0]={communicationType[0]}&communicationType[1]={communicationType[1]}&recipientType[0]={recipientType[0]}&recipientType[1]={recipientType[1]}&id[0]={id[0]}&id[1]={id[1]}&status[0]={status[0]}&status[1]={status[1]}&year={year}&pageNumber={pageNumber}&pageSize={pageSize}

Request Information

URI Parameters

Name	Type	Additional information
communicationType	Collection of string	Required
recipientType	Collection of string	Required
id	Collection of integer	Required
status	Collection of string	Required
year	integer	None.
pageNumber	integer	None.
pageSize	integer	None.

Body Parameters

None.

Response Information

Resource Description

WebMethodResultOfPaginatedResultsOfCampaign

Name	Type	Additional information
Result	PaginatedResultsOfCampaign	None.
Success	boolean	None.
ErrorText	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": {
    "TotalCount": 1,
    "Next": "sample string 2",
    "Results": [
      null,
      {
        "Id": 1,
        "Name": "sample string 2",
        "TemplateId": "sample string 3",
        "RecipientType": "Undefined",
        "CommunicationType": "Undefined",
        "CommunicationStatus": "Undefined",
        "UserId": 7,
        "FilterSetId": 1,
        "CreatedDate": "2024-05-08T01:23:23Z",
        "CreatedPersonId": null,
        "UpdatedDate": "0001-01-01T07:00:00Z",
        "UpdatedPersonId": null,
        "UpdatedBy": null,
        "Subject": null,
        "CommunicationVersion": "Undefined",
        "Schedule": null
      }
    ]
  },
  "Success": true,
  "ErrorText": "sample string 2"
}

application/javascript

Sample:

{"Result":{"TotalCount":1,"Next":"sample string 2","Results":[null,{"Id":1,"Name":"sample string 2","TemplateId":"sample string 3","RecipientType":"Undefined","CommunicationType":"Undefined","CommunicationStatus":"Undefined","UserId":7,"FilterSetId":1,"CreatedDate":"2024-05-08T01:23:23Z","CreatedPersonId":null,"UpdatedDate":"0001-01-01T07:00:00Z","UpdatedPersonId":null,"UpdatedBy":null,"Subject":null,"CommunicationVersion":"Undefined","Schedule":null}]},"Success":true,"ErrorText":"sample string 2"}

application/xml, text/xml

Sample:

<WebMethodResultOfPaginatedResultsOfCampaign xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Success>true</Success>
  <ErrorText>sample string 2</ErrorText>
  <Result>
    <TotalCount>1</TotalCount>
    <Next>sample string 2</Next>
    <Results>
      <Campaign xsi:nil="true" />
      <Campaign>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <TemplateId>sample string 3</TemplateId>
        <ObjectTypeFlag>Undefined</ObjectTypeFlag>
        <RecipientType>Undefined</RecipientType>
        <CommunicationTypeFlag>Undefined</CommunicationTypeFlag>
        <CommunicationType>Undefined</CommunicationType>
        <Status>Undefined</Status>
        <CommunicationStatus>Undefined</CommunicationStatus>
        <UserId>7</UserId>
        <FilterSetId>1</FilterSetId>
        <Created />
        <CreatedDate>2024-05-08T01:23:23Z</CreatedDate>
        <CreatedPersonId xsi:nil="true" />
        <Updated>0001-01-01T00:00:00</Updated>
        <UpdatedDate>0001-01-01T07:00:00Z</UpdatedDate>
        <UpdatedPersonId xsi:nil="true" />
        <Version>Undefined</Version>
        <CommunicationVersion>Undefined</CommunicationVersion>
        <Schedule xsi:nil="true" />
      </Campaign>
    </Results>
  </Result>
</WebMethodResultOfPaginatedResultsOfCampaign>